Repository navigation
Improve ngdoc for params and returns. - #7
Merged
Merged
Conversation
Member
There was a problem hiding this comment.
You must supply an empty object? I guess this could be a bit more explicit.
Member
Author
There was a problem hiding this comment.
The argument is optional (as described by {Object=}), so you can omit it.
I have improved the description, see the new fixup commit.
Member
Author
There was a problem hiding this comment.
For the record: postData has similar description. However, it is a required argument, so the user must supply the value, even if it is {}. At least according to Angular docs, I didn't check sources.
Member
|
👍 |
Split `accepts` arguments into `parameters` and `postData` for POST/PUT request. When `returns` is a single root argument, include its description in the @return comment. Fix indentation where it was not consistent and/or caused different markdown output than intended.
bajtos
added a commit
that referenced
this pull request
Feb 3, 2014
…ion-in-ngdoc Improve ngdoc for params and returns.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Split
acceptsarguments intoparametersandpostDatafor POST/PUT requests.When
returnsis a single root argument, include its description in the@returncomment.Fix indentation where it was not consistent and/or caused different markdown output than intended.
These changes should improve the documentation of
User.login, especially after strongloop/loopback#163./to @ritch please review.
The diffs of the code-gen template are rather difficult to read. Suggestions on how to make the template easier to read are very welcome.